Cisco-IOS-XR-ipv4-hsrp-cfg API API Reference
API generated from Cisco-IOS-XR-ipv4-hsrp-cfg@2017-11-05.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
HSRP - Update
Update operation of resource: hsrp
hsrpbody object
Request Content-Types: application/json
Request Example
{ {
"mac-refresh": "integer", HSRP MGO slave MAC refresh rate
range: "0..10000"
default: "60"
"interface-name": "string", Interface being tracked "detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby hsrp
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by\nhsrp
units: "millisecond"
}, "reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"minimum-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"redirects-disable": "null", Disable HSRP filtered ICMP redirects
"use-bia": "null", Use burned-in address {
"follow": "string", HSRP Group name for this slave to follow
"virtual-mac-address": "string", HSRP MAC address "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095" "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, {
"address": "string" HSRP IP address
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
},
"session-name": "string", HSRP Session name (for MGO)
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}, {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
]
}, "state-change-disable": "null" HSRP state change IOS messages disable
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HSRP - Create
Create operation of resource: hsrp
hsrpbody object
Request Content-Types: application/json
Request Example
{ {
"mac-refresh": "integer", HSRP MGO slave MAC refresh rate
range: "0..10000"
default: "60"
"interface-name": "string", Interface being tracked "detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby hsrp
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by\nhsrp
units: "millisecond"
}, "reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"minimum-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"redirects-disable": "null", Disable HSRP filtered ICMP redirects
"use-bia": "null", Use burned-in address {
"follow": "string", HSRP Group name for this slave to follow
"virtual-mac-address": "string", HSRP MAC address "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095" "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, {
"address": "string" HSRP IP address
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
},
"session-name": "string", HSRP Session name (for MGO)
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}, {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
]
}, "state-change-disable": "null" HSRP state change IOS messages disable
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HSRP - Delete
Delete operation of resource: hsrp
Successful operation
Internal Error
Response Content-Types: application/json
HSRP - Retrieve
Retrieve operation of resource: hsrp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mac-refresh": "integer", HSRP MGO slave MAC refresh rate
range: "0..10000"
default: "60"
"interface-name": "string", Interface being tracked "detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby hsrp
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by\nhsrp
units: "millisecond"
}, "reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"minimum-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"redirects-disable": "null", Disable HSRP filtered ICMP redirects
"use-bia": "null", Use burned-in address {
"follow": "string", HSRP Group name for this slave to follow
"virtual-mac-address": "string", HSRP MAC address "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095" "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, {
"address": "string" HSRP IP address
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
},
"session-name": "string", HSRP Session name (for MGO)
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}, {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
]
}, "state-change-disable": "null" HSRP state change IOS messages disable
}
}
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"mac-refresh": "integer", HSRP MGO slave MAC refresh rate
range: "0..10000"
default: "60"
"interface-name": "string", Interface being tracked "detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby hsrp
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by\nhsrp
units: "millisecond"
}, "reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"minimum-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"redirects-disable": "null", Disable HSRP filtered ICMP redirects
"use-bia": "null", Use burned-in address {
"follow": "string", HSRP Group name for this slave to follow
"virtual-mac-address": "string", HSRP MAC address "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095" "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, {
"address": "string" HSRP IP address
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
},
"session-name": "string", HSRP Session name (for MGO)
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}, {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"mac-refresh": "integer", HSRP MGO slave MAC refresh rate
range: "0..10000"
default: "60"
"interface-name": "string", Interface being tracked "detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby hsrp
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by\nhsrp
units: "millisecond"
}, "reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"minimum-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"redirects-disable": "null", Disable HSRP filtered ICMP redirects
"use-bia": "null", Use burned-in address {
"follow": "string", HSRP Group name for this slave to follow
"virtual-mac-address": "string", HSRP MAC address "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095" "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, {
"address": "string" HSRP IP address
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
},
"session-name": "string", HSRP Session name (for MGO)
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}, {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mac-refresh": "integer", HSRP MGO slave MAC refresh rate
range: "0..10000"
default: "60"
"interface-name": "string", Interface being tracked "detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby hsrp
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by\nhsrp
units: "millisecond"
}, "reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"minimum-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"redirects-disable": "null", Disable HSRP filtered ICMP redirects
"use-bia": "null", Use burned-in address {
"follow": "string", HSRP Group name for this slave to follow
"virtual-mac-address": "string", HSRP MAC address "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095" "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, {
"address": "string" HSRP IP address
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
},
"session-name": "string", HSRP Session name (for MGO)
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}, {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"mac-refresh": "integer", HSRP MGO slave MAC refresh rate
range: "0..10000"
default: "60"
"interface-name": "string", Interface being tracked "detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby hsrp
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by\nhsrp
units: "millisecond"
}, "reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"minimum-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"redirects-disable": "null", Disable HSRP filtered ICMP redirects
"use-bia": "null", Use burned-in address {
"follow": "string", HSRP Group name for this slave to follow
"virtual-mac-address": "string", HSRP MAC address "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095" "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, {
"address": "string" HSRP IP address
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
},
"session-name": "string", HSRP Session name (for MGO)
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}, {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"mac-refresh": "integer", HSRP MGO slave MAC refresh rate
range: "0..10000"
default: "60"
"interface-name": "string", Interface being tracked "detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby hsrp
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by\nhsrp
units: "millisecond"
}, "reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"minimum-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"redirects-disable": "null", Disable HSRP filtered ICMP redirects
"use-bia": "null", Use burned-in address {
"follow": "string", HSRP Group name for this slave to follow
"virtual-mac-address": "string", HSRP MAC address "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095" "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, {
"address": "string" HSRP IP address
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
},
"session-name": "string", HSRP Session name (for MGO)
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}, {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mac-refresh": "integer", HSRP MGO slave MAC refresh rate
range: "0..10000"
default: "60"
"interface-name": "string", Interface being tracked "detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby hsrp
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by\nhsrp
units: "millisecond"
}, "reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"minimum-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"redirects-disable": "null", Disable HSRP filtered ICMP redirects
"use-bia": "null", Use burned-in address {
"follow": "string", HSRP Group name for this slave to follow
"virtual-mac-address": "string", HSRP MAC address "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095" "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP IP address
}, "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, {
"address": "string" HSRP IP address
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
},
"session-name": "string", HSRP Session name (for MGO)
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}, {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
]
}
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"follow": "string", HSRP Group name for this slave to follow
"virtual-mac-address": "string", HSRP MAC address "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP virtual global IPv6 address
}, {
"address": "string" HSRP virtual global IPv6 address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095" "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP virtual global IPv6 address
}, "interface-name": "string", Interface being tracked
"address": "string" HSRP virtual global IPv6 address
},
"virtual-mac-address": "string", HSRP MAC address {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, {
"address": "string" HSRP virtual global IPv6 address
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
},
"session-name": "string", HSRP Session name (for MGO)
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"follow": "string", HSRP Group name for this slave to follow
"virtual-mac-address": "string", HSRP MAC address "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP virtual global IPv6 address
}, {
"address": "string" HSRP virtual global IPv6 address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095" "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP virtual global IPv6 address
}, "interface-name": "string", Interface being tracked
"address": "string" HSRP virtual global IPv6 address
},
"virtual-mac-address": "string", HSRP MAC address {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, {
"address": "string" HSRP virtual global IPv6 address
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
},
"session-name": "string", HSRP Session name (for MGO)
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"follow": "string", HSRP Group name for this slave to follow
"virtual-mac-address": "string", HSRP MAC address "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP virtual global IPv6 address
}, {
"address": "string" HSRP virtual global IPv6 address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095" "auto-configure": "string", Linklocal Configuration Type
"address": "string" HSRP virtual global IPv6 address
}, "interface-name": "string", Interface being tracked
"address": "string" HSRP virtual global IPv6 address
},
"virtual-mac-address": "string", HSRP MAC address {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, {
"address": "string" HSRP virtual global IPv6 address
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
},
"session-name": "string", HSRP Session name (for MGO)
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
VERSION2 - Update
Update operation of resource: version2
version2body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address : {Primary HSRP IP address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERSION2 - Create
Create operation of resource: version2
version2body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address : {Primary HSRP IP address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERSION2 - Delete
Delete operation of resource: version2
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VERSION2 - Retrieve
Retrieve operation of resource: version2
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address : {Primary HSRP IP address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address : {Primary HSRP IP address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address : {Primary HSRP IP address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address : {Primary HSRP IP address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
GROUP - Update
Update operation of resource: group
groupbody object
ID of interface-name
ID of group-number
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address : {Primary HSRP IP address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of interface-name
ID of group-number
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address : {Primary HSRP IP address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address : {Primary HSRP IP address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of interface-name
ID of group-number
Successful operation
Internal Error
TRACKED-INTERFACES - Update
Update operation of resource: tracked-interfaces
tracked-interfacesbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACES - Create
Create operation of resource: tracked-interfaces
tracked-interfacesbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACES - Delete
Delete operation of resource: tracked-interfaces
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACES - Retrieve
Retrieve operation of resource: tracked-interfaces
ID of interface-name
ID of group-number
Successful operation
Internal Error
TRACKED-INTERFACE - Update
Update operation of resource: tracked-interface
tracked-interfacebody object
ID of interface-name
ID of group-number
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACE - Create
Create operation of resource: tracked-interface
tracked-interfacebody object
ID of interface-name
ID of group-number
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACE - Delete
Delete operation of resource: tracked-interface
ID of interface-name
ID of group-number
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACE - Retrieve
Retrieve operation of resource: tracked-interface
ID of interface-name
ID of group-number
ID of interface-name
Successful operation
Internal Error
TRACKED-OBJECTS - Update
Update operation of resource: tracked-objects
tracked-objectsbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Create
Create operation of resource: tracked-objects
tracked-objectsbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Delete
Delete operation of resource: tracked-objects
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Retrieve
Retrieve operation of resource: tracked-objects
ID of interface-name
ID of group-number
Successful operation
Internal Error
TRACKED-OBJECT - Update
Update operation of resource: tracked-object
tracked-objectbody object
ID of interface-name
ID of group-number
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Create
Create operation of resource: tracked-object
tracked-objectbody object
ID of interface-name
ID of group-number
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Delete
Delete operation of resource: tracked-object
ID of interface-name
ID of group-number
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Retrieve
Retrieve operation of resource: tracked-object
ID of interface-name
ID of group-number
ID of object-name
Successful operation
Internal Error
TIMERS - Update
Update operation of resource: timers
timersbody object
ID of interface-name
ID of group-number
Request Content-Types: application/json
Request Example
{ "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Create
Create operation of resource: timers
timersbody object
ID of interface-name
ID of group-number
Request Content-Types: application/json
Request Example
{ "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Delete
Delete operation of resource: timers
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Retrieve
Retrieve operation of resource: timers
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}
}
LINK-LOCAL-IPV6-ADDRESS - Update
Update operation of resource: link-local-ipv6-address
link-local-ipv6-addressbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
LINK-LOCAL-IPV6-ADDRESS - Create
Create operation of resource: link-local-ipv6-address
link-local-ipv6-addressbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
LINK-LOCAL-IPV6-ADDRESS - Delete
Delete operation of resource: link-local-ipv6-address
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
LINK-LOCAL-IPV6-ADDRESS - Retrieve
Retrieve operation of resource: link-local-ipv6-address
ID of interface-name
ID of group-number
Successful operation
Internal Error
GLOBAL-IPV6-ADDRESSES - Update
Update operation of resource: global-ipv6-addresses
global-ipv6-addressesbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESSES - Create
Create operation of resource: global-ipv6-addresses
global-ipv6-addressesbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESSES - Delete
Delete operation of resource: global-ipv6-addresses
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESSES - Retrieve
Retrieve operation of resource: global-ipv6-addresses
ID of interface-name
ID of group-number
Successful operation
Internal Error
GLOBAL-IPV6-ADDRESS - Update
Update operation of resource: global-ipv6-address
global-ipv6-addressbody object
ID of interface-name
ID of group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESS - Create
Create operation of resource: global-ipv6-address
global-ipv6-addressbody object
ID of interface-name
ID of group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESS - Delete
Delete operation of resource: global-ipv6-address
ID of interface-name
ID of group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESS - Retrieve
Retrieve operation of resource: global-ipv6-address
ID of interface-name
ID of group-number
ID of address
Successful operation
Internal Error
SLAVE-GROUPS - Update
Update operation of resource: slave-groups
slave-groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-GROUPS - Create
Create operation of resource: slave-groups
slave-groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-GROUPS - Delete
Delete operation of resource: slave-groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-GROUPS - Retrieve
Retrieve operation of resource: slave-groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}
}
SLAVE-GROUP - Update
Update operation of resource: slave-group
slave-groupbody object
ID of interface-name
ID of slave-group-number
Request Content-Types: application/json
Request Example
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-GROUP - Create
Create operation of resource: slave-group
slave-groupbody object
ID of interface-name
ID of slave-group-number
Request Content-Types: application/json
Request Example
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-GROUP - Delete
Delete operation of resource: slave-group
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-GROUP - Retrieve
Retrieve operation of resource: slave-group
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address : {Secondary HSRP IP address Table : [No description {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}
LINK-LOCAL-IPV6-ADDRESS - Update
Update operation of resource: link-local-ipv6-address
link-local-ipv6-addressbody object
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
Response Content-Types: application/json
LINK-LOCAL-IPV6-ADDRESS - Create
Create operation of resource: link-local-ipv6-address
link-local-ipv6-addressbody object
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
Response Content-Types: application/json
LINK-LOCAL-IPV6-ADDRESS - Delete
Delete operation of resource: link-local-ipv6-address
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
Response Content-Types: application/json
LINK-LOCAL-IPV6-ADDRESS - Retrieve
Retrieve operation of resource: link-local-ipv6-address
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
GLOBAL-IPV6-ADDRESSES - Update
Update operation of resource: global-ipv6-addresses
global-ipv6-addressesbody object
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESSES - Create
Create operation of resource: global-ipv6-addresses
global-ipv6-addressesbody object
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESSES - Delete
Delete operation of resource: global-ipv6-addresses
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESSES - Retrieve
Retrieve operation of resource: global-ipv6-addresses
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
GLOBAL-IPV6-ADDRESS - Update
Update operation of resource: global-ipv6-address
global-ipv6-addressbody object
ID of interface-name
ID of slave-group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESS - Create
Create operation of resource: global-ipv6-address
global-ipv6-addressbody object
ID of interface-name
ID of slave-group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESS - Delete
Delete operation of resource: global-ipv6-address
ID of interface-name
ID of slave-group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-IPV6-ADDRESS - Retrieve
Retrieve operation of resource: global-ipv6-address
ID of interface-name
ID of slave-group-number
ID of address
Successful operation
Internal Error
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of interface-name
Successful operation
Internal Error
DELAY - Update
Update operation of resource: delay
delaybody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Create
Create operation of resource: delay
delaybody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Delete
Delete operation of resource: delay
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Retrieve
Retrieve operation of resource: delay
ID of interface-name
Successful operation
Internal Error
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}, {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
}
SLAVE-GROUPS - Update
Update operation of resource: slave-groups
slave-groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-GROUPS - Create
Create operation of resource: slave-groups
slave-groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-GROUPS - Delete
Delete operation of resource: slave-groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-GROUPS - Retrieve
Retrieve operation of resource: slave-groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}
}
SLAVE-GROUP - Update
Update operation of resource: slave-group
slave-groupbody object
ID of interface-name
ID of slave-group-number
Request Content-Types: application/json
Request Example
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-GROUP - Create
Create operation of resource: slave-group
slave-groupbody object
ID of interface-name
ID of slave-group-number
Request Content-Types: application/json
Request Example
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-GROUP - Delete
Delete operation of resource: slave-group
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
Response Content-Types: application/json
SLAVE-GROUP - Retrieve
Retrieve operation of resource: slave-group
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"follow": "string", HSRP Group name for this slave to follow
"primary-ipv4-address": "string", Primary HSRP IP address
"virtual-mac-address": "string", HSRP MAC address {
"address": "string" HSRP IP address
}
]
},
"slave-group-number": "integer" HSRP group number
range: "0..4095"
}
]
}
SECONDARY-IPV4-ADDRESSES - Update
Update operation of resource: secondary-ipv4-addresses
secondary-ipv4-addressesbody object
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Create
Create operation of resource: secondary-ipv4-addresses
secondary-ipv4-addressesbody object
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Delete
Delete operation of resource: secondary-ipv4-addresses
ID of interface-name
ID of slave-group-number
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Retrieve
Retrieve operation of resource: secondary-ipv4-addresses
ID of interface-name
ID of slave-group-number
SECONDARY-IPV4-ADDRESS - Update
Update operation of resource: secondary-ipv4-address
secondary-ipv4-addressbody object
ID of interface-name
ID of slave-group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Create
Create operation of resource: secondary-ipv4-address
secondary-ipv4-addressbody object
ID of interface-name
ID of slave-group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Delete
Delete operation of resource: secondary-ipv4-address
ID of interface-name
ID of slave-group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Retrieve
Retrieve operation of resource: secondary-ipv4-address
ID of interface-name
ID of slave-group-number
ID of address
Successful operation
Internal Error
VERSION1 - Update
Update operation of resource: version1
version1body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERSION1 - Create
Create operation of resource: version1
version1body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERSION1 - Delete
Delete operation of resource: version1
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VERSION1 - Retrieve
Retrieve operation of resource: version1
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer", Force active if higher priority
default: "0"
"authentication": "string" Authentication string
}
]
}
}
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
GROUP - Update
Update operation of resource: group
groupbody object
ID of interface-name
ID of group-number
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of interface-name
ID of group-number
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
TRACKED-INTERFACES - Update
Update operation of resource: tracked-interfaces
tracked-interfacesbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACES - Create
Create operation of resource: tracked-interfaces
tracked-interfacesbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACES - Delete
Delete operation of resource: tracked-interfaces
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACES - Retrieve
Retrieve operation of resource: tracked-interfaces
ID of interface-name
ID of group-number
Successful operation
Internal Error
TRACKED-INTERFACE - Update
Update operation of resource: tracked-interface
tracked-interfacebody object
ID of interface-name
ID of group-number
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACE - Create
Create operation of resource: tracked-interface
tracked-interfacebody object
ID of interface-name
ID of group-number
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACE - Delete
Delete operation of resource: tracked-interface
ID of interface-name
ID of group-number
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACE - Retrieve
Retrieve operation of resource: tracked-interface
ID of interface-name
ID of group-number
ID of interface-name
Successful operation
Internal Error
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of interface-name
ID of group-number
Successful operation
Internal Error
TRACKED-OBJECTS - Update
Update operation of resource: tracked-objects
tracked-objectsbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Create
Create operation of resource: tracked-objects
tracked-objectsbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Delete
Delete operation of resource: tracked-objects
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Retrieve
Retrieve operation of resource: tracked-objects
ID of interface-name
ID of group-number
Successful operation
Internal Error
TRACKED-OBJECT - Update
Update operation of resource: tracked-object
tracked-objectbody object
ID of interface-name
ID of group-number
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Create
Create operation of resource: tracked-object
tracked-objectbody object
ID of interface-name
ID of group-number
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Delete
Delete operation of resource: tracked-object
ID of interface-name
ID of group-number
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Retrieve
Retrieve operation of resource: tracked-object
ID of interface-name
ID of group-number
ID of object-name
Successful operation
Internal Error
TIMERS - Update
Update operation of resource: timers
timersbody object
ID of interface-name
ID of group-number
Request Content-Types: application/json
Request Example
{ "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Create
Create operation of resource: timers
timersbody object
ID of interface-name
ID of group-number
Request Content-Types: application/json
Request Example
{ "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Delete
Delete operation of resource: timers
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Retrieve
Retrieve operation of resource: timers
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}
}
PRIMARY-IPV4-ADDRESS - Update
Update operation of resource: primary-ipv4-address
primary-ipv4-addressbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
PRIMARY-IPV4-ADDRESS - Create
Create operation of resource: primary-ipv4-address
primary-ipv4-addressbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
PRIMARY-IPV4-ADDRESS - Delete
Delete operation of resource: primary-ipv4-address
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
PRIMARY-IPV4-ADDRESS - Retrieve
Retrieve operation of resource: primary-ipv4-address
ID of interface-name
ID of group-number
Successful operation
Internal Error
SECONDARY-IPV4-ADDRESSES - Update
Update operation of resource: secondary-ipv4-addresses
secondary-ipv4-addressesbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Create
Create operation of resource: secondary-ipv4-addresses
secondary-ipv4-addressesbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Delete
Delete operation of resource: secondary-ipv4-addresses
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Retrieve
Retrieve operation of resource: secondary-ipv4-addresses
ID of interface-name
ID of group-number
SECONDARY-IPV4-ADDRESS - Update
Update operation of resource: secondary-ipv4-address
secondary-ipv4-addressbody object
ID of interface-name
ID of group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Create
Create operation of resource: secondary-ipv4-address
secondary-ipv4-addressbody object
ID of interface-name
ID of group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Delete
Delete operation of resource: secondary-ipv4-address
ID of interface-name
ID of group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Retrieve
Retrieve operation of resource: secondary-ipv4-address
ID of interface-name
ID of group-number
ID of address
Successful operation
Internal Error
VERSION2 - Update
Update operation of resource: version2
version2body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERSION2 - Create
Create operation of resource: version2
version2body object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERSION2 - Delete
Delete operation of resource: version2
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VERSION2 - Retrieve
Retrieve operation of resource: version2
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
}
GROUP - Update
Update operation of resource: group
groupbody object
ID of interface-name
ID of group-number
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of interface-name
ID of group-number
Request Content-Types: application/json
Request Example
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-number": "integer", HSRP group number
range: "0..4095"
"session-name": "string", HSRP Session name (for MGO) "interface-name": "string", Interface being tracked
"address": "string" HSRP IP address
},
"virtual-mac-address": "string", HSRP MAC address "virtual-ip-learn": "boolean", TRUE if the HSRP protocol is to learn the\nvirtual IP address it is to use
"address": "string" HSRP IP address
}, {
"interface-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
},
"priority": "integer", Priority value
range: "0..255"
default: "100" {
"object-name": "string", Interface being tracked
"priority-decrement": "integer" Priority decrement
range: "1..255"
}
]
}, "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}, {
"address": "string" HSRP IP address
}
]
},
"preempt": "integer" Force active if higher priority
default: "0"
}
]
}
SECONDARY-IPV4-ADDRESSES - Update
Update operation of resource: secondary-ipv4-addresses
secondary-ipv4-addressesbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Create
Create operation of resource: secondary-ipv4-addresses
secondary-ipv4-addressesbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Delete
Delete operation of resource: secondary-ipv4-addresses
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESSES - Retrieve
Retrieve operation of resource: secondary-ipv4-addresses
ID of interface-name
ID of group-number
SECONDARY-IPV4-ADDRESS - Update
Update operation of resource: secondary-ipv4-address
secondary-ipv4-addressbody object
ID of interface-name
ID of group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Create
Create operation of resource: secondary-ipv4-address
secondary-ipv4-addressbody object
ID of interface-name
ID of group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Delete
Delete operation of resource: secondary-ipv4-address
ID of interface-name
ID of group-number
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-IPV4-ADDRESS - Retrieve
Retrieve operation of resource: secondary-ipv4-address
ID of interface-name
ID of group-number
ID of address
Successful operation
Internal Error
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of interface-name
ID of group-number
Successful operation
Internal Error
PRIMARY-IPV4-ADDRESS - Update
Update operation of resource: primary-ipv4-address
primary-ipv4-addressbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
PRIMARY-IPV4-ADDRESS - Create
Create operation of resource: primary-ipv4-address
primary-ipv4-addressbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
PRIMARY-IPV4-ADDRESS - Delete
Delete operation of resource: primary-ipv4-address
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
PRIMARY-IPV4-ADDRESS - Retrieve
Retrieve operation of resource: primary-ipv4-address
ID of interface-name
ID of group-number
Successful operation
Internal Error
TRACKED-OBJECTS - Update
Update operation of resource: tracked-objects
tracked-objectsbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Create
Create operation of resource: tracked-objects
tracked-objectsbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Delete
Delete operation of resource: tracked-objects
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECTS - Retrieve
Retrieve operation of resource: tracked-objects
ID of interface-name
ID of group-number
Successful operation
Internal Error
TRACKED-OBJECT - Update
Update operation of resource: tracked-object
tracked-objectbody object
ID of interface-name
ID of group-number
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Create
Create operation of resource: tracked-object
tracked-objectbody object
ID of interface-name
ID of group-number
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Delete
Delete operation of resource: tracked-object
ID of interface-name
ID of group-number
ID of object-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-OBJECT - Retrieve
Retrieve operation of resource: tracked-object
ID of interface-name
ID of group-number
ID of object-name
Successful operation
Internal Error
TRACKED-INTERFACES - Update
Update operation of resource: tracked-interfaces
tracked-interfacesbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACES - Create
Create operation of resource: tracked-interfaces
tracked-interfacesbody object
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACES - Delete
Delete operation of resource: tracked-interfaces
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACES - Retrieve
Retrieve operation of resource: tracked-interfaces
ID of interface-name
ID of group-number
Successful operation
Internal Error
TRACKED-INTERFACE - Update
Update operation of resource: tracked-interface
tracked-interfacebody object
ID of interface-name
ID of group-number
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACE - Create
Create operation of resource: tracked-interface
tracked-interfacebody object
ID of interface-name
ID of group-number
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACE - Delete
Delete operation of resource: tracked-interface
ID of interface-name
ID of group-number
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACKED-INTERFACE - Retrieve
Retrieve operation of resource: tracked-interface
ID of interface-name
ID of group-number
ID of interface-name
Successful operation
Internal Error
TIMERS - Update
Update operation of resource: timers
timersbody object
ID of interface-name
ID of group-number
Request Content-Types: application/json
Request Example
{ "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Create
Create operation of resource: timers
timersbody object
ID of interface-name
ID of group-number
Request Content-Types: application/json
Request Example
{ "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Delete
Delete operation of resource: timers
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Retrieve
Retrieve operation of resource: timers
ID of interface-name
ID of group-number
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hold-msec-flag": "boolean", TRUE - Hold time configured in\nmilliseconds, FALSE - Hold time\nconfigured in seconds
"hello-msec": "integer", Hello time in msecs
range: "100..3000"
units: "millisecond"
"hold-sec": "integer", Hold time in seconds
range: "1..255"
units: "second"
default: "10"
"hold-msec": "integer", Hold time in msecs
range: "100..3000"
units: "millisecond"
"hello-sec": "integer", Hello time in seconds
range: "1..255"
units: "second"
default: "3"
"hello-msec-flag": "boolean" TRUE - Hello time configured in\nmilliseconds, FALSE - Hello time\nconfigured in seconds
}
}
LOGGING - Update
Update operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
ENCRYPTED-COMMUNITY-MAPS - Update
Update operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Create
Create operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Delete
Delete operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
ENCRYPTED-COMMUNITY-MAP - Update
Update operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Create
Create operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Delete
Delete operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
VIEWS - Update
Update operation of resource: views
viewsbody object
Request Content-Types: application/json
Request Example
{ {
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Create
Create operation of resource: views
viewsbody object
Request Content-Types: application/json
Request Example
{ {
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Delete
Delete operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Retrieve
Retrieve operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
}
]
}
}
VIEW - Update
Update operation of resource: view
viewbody object
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Create
Create operation of resource: view
viewbody object
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Delete
Delete operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Retrieve
Retrieve operation of resource: view
ID of view-name family
Successful operation
Internal Error
LOGGING - Update
Update operation of resource: logging
loggingbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
ADMINISTRATION - Update
Update operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Create
Create operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Delete
Delete operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Retrieve
Retrieve operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
}
DEFAULT-COMMUNITIES - Update
Update operation of resource: default-communities
default-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Create
Create operation of resource: default-communities
default-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Delete
Delete operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Retrieve
Retrieve operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
DEFAULT-COMMUNITY - Update
Update operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Create
Create operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Delete
Delete operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Retrieve
Retrieve operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
ENCRYPTED-COMMUNITIES - Update
Update operation of resource: encrypted-communities
encrypted-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Create
Create operation of resource: encrypted-communities
encrypted-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Delete
Delete operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
ENCRYPTED-COMMUNITY - Update
Update operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Create
Create operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Delete
Delete operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
AGENT - Update
Update operation of resource: agent
agentbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Create
Create operation of resource: agent
agentbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Delete
Delete operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Retrieve
Retrieve operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
}
ENGINE-ID - Update
Update operation of resource: engine-id
engine-idbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Create
Create operation of resource: engine-id
engine-idbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Delete
Delete operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Retrieve
Retrieve operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
REMOTES - Update
Update operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Create
Create operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Delete
Delete operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Retrieve
Retrieve operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
}
}
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of remote-address
Successful operation
Internal Error
TRAP - Update
Update operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{ "queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Create
Create operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{ "queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Delete
Delete operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Retrieve
Retrieve operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
}
}
DROP-PACKET - Update
Update operation of resource: drop-packet
drop-packetbody object
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Create
Create operation of resource: drop-packet
drop-packetbody object
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Delete
Delete operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Retrieve
Retrieve operation of resource: drop-packet
Successful operation
Internal Error
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
SYSTEM - Update
Update operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{ "chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Create
Create operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{ "chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Delete
Delete operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Retrieve
Retrieve operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
}
}
TARGET - Update
Update operation of resource: target
targetbody object
Request Content-Types: application/json
Request Example
{ : {SNMP Target address configurations : [No description {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list : {List of VRF Name for a target list : [No description {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
Request Content-Types: application/json
Request Example
{ : {SNMP Target address configurations : [No description {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list : {List of VRF Name for a target list : [No description {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {SNMP Target address configurations : [No description {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list : {List of VRF Name for a target list : [No description {
"name": "string" VRF Name
}
]
}
}
}
TARGETS - Update
Update operation of resource: targets
targetsbody object
Request Content-Types: application/json
Request Example
{ { {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Create
Create operation of resource: targets
targetsbody object
Request Content-Types: application/json
Request Example
{ { {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Delete
Delete operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Retrieve
Retrieve operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
]
}
}
TARGET - Update
Update operation of resource: target
targetbody object
ID of target-list-name
Request Content-Types: application/json
Request Example
{ {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of target-list-name
Request Content-Types: application/json
Request Example
{ {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
}
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of target-list-name
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
TARGET-ADDRESSES - Update
Update operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Create
Create operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Delete
Delete operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Retrieve
Retrieve operation of resource: target-addresses
ID of target-list-name
TARGET-ADDRESS - Update
Update operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Create
Create operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Delete
Delete operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
NOTIFICATION - Update
Update operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable CISCO-HSRP-MIB notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}, "enable": "null" Enable CISCO-HSRP-MIB notifications
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Create
Create operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable CISCO-HSRP-MIB notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}, "enable": "null" Enable CISCO-HSRP-MIB notifications
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Delete
Delete operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Retrieve
Retrieve operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable CISCO-HSRP-MIB notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}, "enable": "null" Enable CISCO-HSRP-MIB notifications
}
}
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
HSRP - Update
Update operation of resource: hsrp
hsrpbody object
Successful operation
Internal Error
Response Content-Types: application/json
HSRP - Create
Create operation of resource: hsrp
hsrpbody object
Successful operation
Internal Error
Response Content-Types: application/json
HSRP - Delete
Delete operation of resource: hsrp
Successful operation
Internal Error
Response Content-Types: application/json
HSRP - Retrieve
Retrieve operation of resource: hsrp
Successful operation
Internal Error
CORRELATOR - Update
Update operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Ruleset name
}
]
}, { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
},
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Create
Create operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Ruleset name
}
]
}, { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
},
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Delete
Delete operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Retrieve
Retrieve operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Ruleset name
}
]
}, { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
},
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
}
}
RULES - Update
Update operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Create
Create operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Delete
Delete operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Retrieve
Retrieve operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
}
]
}
}
RULE - Update
Update operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Create
Create operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Delete
Delete operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Retrieve
Retrieve operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
}
]
}
ROOT-CAUSES - Update
Update operation of resource: root-causes
root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Create
Create operation of resource: root-causes
root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Delete
Delete operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Retrieve
Retrieve operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
}
ROOT-CAUSE - Update
Update operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Create
Create operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Delete
Delete operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Retrieve
Retrieve operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
NON-ROOT-CAUSES - Update
Update operation of resource: non-root-causes
non-root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Create
Create operation of resource: non-root-causes
non-root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Delete
Delete operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Retrieve
Retrieve operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
}
NON-ROOT-CAUSE - Update
Update operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Create
Create operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Delete
Delete operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Retrieve
Retrieve operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
RULE-SETS - Update
Update operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Create
Create operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Delete
Delete operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Retrieve
Retrieve operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
}
RULE-SET - Update
Update operation of resource: rule-set
rule-setbody object
ID of name
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Create
Create operation of resource: rule-set
rule-setbody object
ID of name
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Delete
Delete operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Retrieve
Retrieve operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
RULENAMES - Update
Update operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Create
Create operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Delete
Delete operation of resource: rulenames
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Retrieve
Retrieve operation of resource: rulenames
ID of name
RULENAME - Update
Update operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Create
Create operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Delete
Delete operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Retrieve
Retrieve operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
BULK-STATS - Update
Update operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{ "memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte" {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" The name of the schema
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}, {
"object-list-name": "string", Name of the object List {
"oid": "string" Object name or OID
}
]
},
"type": "null" Configure schema name
}
]
}, {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Create
Create operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{ "memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte" {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" The name of the schema
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}, {
"object-list-name": "string", Name of the object List {
"oid": "string" Object name or OID
}
]
},
"type": "null" Configure schema name
}
]
}, {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Delete
Delete operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Retrieve
Retrieve operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte" {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" The name of the schema
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}, {
"object-list-name": "string", Name of the object List {
"oid": "string" Object name or OID
}
]
},
"type": "null" Configure schema name
}
]
}, {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
}
SCHEMAS - Update
Update operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Create
Create operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Delete
Delete operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Retrieve
Retrieve operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
SCHEMA - Update
Update operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Create
Create operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Delete
Delete operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Retrieve
Retrieve operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
INSTANCE - Update
Update operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Create
Create operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Delete
Delete operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Retrieve
Retrieve operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
}
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
Successful operation
Internal Error
OBJECTS - Update
Update operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
ID of object-list-name
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
TRANSFERS - Update
Update operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Create
Create operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Delete
Delete operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Retrieve
Retrieve operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
}
TRANSFER - Update
Update operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Create
Create operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Delete
Delete operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Retrieve
Retrieve operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
TRANSFER-SCHEMAS - Update
Update operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Create
Create operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Delete
Delete operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Retrieve
Retrieve operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
TRANSFER-SCHEMA - Update
Update operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Create
Create operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Delete
Delete operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Retrieve
Retrieve operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
DEFAULT-COMMUNITY-MAPS - Update
Update operation of resource: default-community-maps
default-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Create
Create operation of resource: default-community-maps
default-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Delete
Delete operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
DEFAULT-COMMUNITY-MAP - Update
Update operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Create
Create operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Delete
Delete operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
OVERLOAD-CONTROL - Update
Update operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{ "drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Create
Create operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{ "drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Delete
Delete operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Retrieve
Retrieve operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
}
}
TIMEOUTS - Update
Update operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{ "duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Create
Create operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{ "duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Delete
Delete operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Retrieve
Retrieve operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
}
}
USERS - Update
Update operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Create
Create operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Delete
Delete operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Retrieve
Retrieve operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
}
USER - Update
Update operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Create
Create operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Delete
Delete operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
USER - Retrieve
Retrieve operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
ID of name
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
}
GROUP - Update
Update operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of context-name
Successful operation
Internal Error
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
MIB - Update
Update operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Create
Create operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Delete
Delete operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Retrieve
Retrieve operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{